Add undocumented _heappop_max and _heapreplace_max to heapq stubs#15257
Add undocumented _heappop_max and _heapreplace_max to heapq stubs#15257thiagowfx wants to merge 1 commit intopython:mainfrom
Conversation
Verify these methods exist: ``` ❯ python3 Python 3.9.6 (default, Dec 2 2025, 07:27:58) [Clang 17.0.0 (clang-1700.6.3.2)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> import heapq >>> dir(heapq) ['__about__', '__all__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', '_heapify_max', '_heappop_max', '_heapreplace_max', '_siftdown', '_siftdown_max', '_siftup', '_siftup_max', 'heapify', 'heappop', 'heappush', 'heappushpop', 'heapreplace', 'merge', 'nlargest', 'nsmallest'] ``` Arguably the proper fix is: ```diff -def _heapify_max(heap: list[Any], /) -> None: ... # undocumented +def _heapify_max(heap: Iterable[_S], /) -> None: ... # undocumented +def _heappop_max(heap: Iterable[_S], /) -> _S: ... # undocumented +def _heapreplace_max(heap: Iterable[_S], item: _S, /) -> _S: ... # undocumented ``` Opt in for consistency with the pre-existing `_heapify_max` though.
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
|
We don't add private methods just because they exist, only when people actually need them. Are you using them, or merely adding them for completeness? |
|
Context: I was trying to use a max heap in Python and accidentally(!) discovered
The initial discovery led me to eventually realize that the two methods added to this PR existed, I just found it odd they were not showing up on auto-completion, then I figured out it's because they're not included in this file. To answer your question: IMHO it doesn't make sense to have only
I do not advocate to add all private methods – for example, What are your thoughts? |
2 participants
Verify these methods exist:
Arguably the proper fix is:
Opt in for consistency with the pre-existing
_heapify_maxthough.